Benchmark Results (Julia v1.10)

Benchmark Results (Julia v1)

Hi @abhro, hope you've been well! I love this PR and just wanted to check back in about its current status. I think getting it in would be really helpful for keeping the docs in sync with the QuantityArray PR (#178) I'm working on, especially if we could make the use of @example blocks a bit more ubiquitous here

Hi! I think I've addressed all the changes, it's most likely just the CI checks now

Oh, could we also add the generated index.md file to .gitignore? I accidentally uploaded it in another PR, haha. And probably /test/Manifest.toml for completeness too?

Done!

Sweet, thanks!

Have you been able to generate docs with the Mirror to DAMTP bit btw? I've been finding that since it it relies on an ENV in CI, it fails when I try to build locally, so I've just been commenting it our for now. I'm wondering if it would make sense to hide that bit behind a conditional flag that's called during CI?

Have you been able to generate docs with the Mirror to DAMTP bit btw? I've been finding that since it it relies on an ENV in CI, it fails when I try to build locally, so I've just been commenting it our for now. I'm wondering if it would make sense to hide that bit behind a conditional flag that's called during CI?

I'm guessing this part is meant for @MilesCranmer? I'm not sure I can offer much help on the deployment side of things

Sorry, I should have said "because of the Mirror to DAMTP bit" instead of "with the Mirror to DAMTP bit". In other words, this seems like an issue for anyone trying to build the docs locally, so I just wanted to see if we could smooth that process out a bit for folks.

Similarly, I was wondering if it might also be good to add a tip about using LiveServer.jl with something like:

servedocs(; include_dirs=["src/"], skip_files=["docs/src/index.md"])

so things work well from the jump. Anyway, just wanted to get your perspective to get an idea of if something like this would be helpful or not, haha

Sorry, I should have said "because of the Mirror to DAMTP bit" instead of "with the Mirror to DAMTP bit". In other words, this seems like an issue for anyone trying to build the docs locally, so I just wanted to see if we could smooth that process out a bit for folks.

Mmm, yes, that's probably a good idea to add a guard to check if the build is happening in CI or not.

Cool how about just wrapping the deploydocs bit in something like this?

in_CI_env = get(ENV, "CI", nothing) == "true"

if in_CI_env
    deploydocs(;
        repo="github.com/SymbolicML/DynamicQuantities.jl",
        devbranch="main"
    )

    # Mirror to DAMTP:
    ENV["DOCUMENTER_KEY"] = ENV["DOCUMENTER_KEY_CAM"]
    ENV["GITHUB_REPOSITORY"] = "ai-damtp-cam-ac-uk/dynamicquantities.git"
    deploydocs(;
        repo="github.com/ai-damtp-cam-ac-uk/dynamicquantities.git",
        devbranch="main"
    )
end

That looks ok but the environment variable should be more specific. Like “DEPLOY_DOCUMENTER” or something. And just have the default be “false” rather than nothing

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.21%. Comparing base (3e4e19d) to head (f85fd82).
⚠️ Report is 1 commits behind head on main.

@@           Coverage Diff           @@
##             main     #175   +/-   ##
=======================================
  Coverage   99.21%   99.21%           
=======================================
  Files          21       21           
  Lines        1273     1273           
=======================================
  Hits         1263     1263           
  Misses         10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sweet, thx! Could you also add that CI guard Miles mentioned?

Howdy folks, just wanted to check if there was anything else still needed for this PR. Did we want in_CI_env renamed to DEPLOY_DOCUMENTER? cc: @MilesCranmer